/*
 * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/NameValuePair.java,v 1.17 2004/04/18 23:51:35 jsdever Exp $
 * $Revision: 480424 $
 * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $
 *
 * ====================================================================
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.commons.httpclient;

import java.io.Serializable;

import org.apache.commons.httpclient.util.LangUtils;

/**
 * <p>
 * A simple class encapsulating a name/value pair.
 * </p>
 * 
 * @author <a href="mailto:bcholmes@interlog.com">B.C. Holmes</a>
 * @author Sean C. Sullivan
 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
 * 
 * @version $Revision: 480424 $ $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov
 *          2006) $
 * 
 */
public class NameValuePair implements Serializable {

	// ----------------------------------------------------------- Constructors

	/**
	 * Default constructor.
	 * 
	 */
	public NameValuePair() {
		this(null, null);
	}

	/**
	 * Constructor.
	 * 
	 * @param name
	 *            The name.
	 * @param value
	 *            The value.
	 */
	public NameValuePair(String name, String value) {
		this.name = name;
		this.value = value;
	}

	// ----------------------------------------------------- Instance Variables

	/**
	 * Name.
	 */
	private String name = null;

	/**
	 * Value.
	 */
	private String value = null;

	// ------------------------------------------------------------- Properties

	/**
	 * Set the name.
	 * 
	 * @param name
	 *            The new name
	 * @see #getName()
	 */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * Return the name.
	 * 
	 * @return String name The name
	 * @see #setName(String)
	 */
	public String getName() {
		return name;
	}

	/**
	 * Set the value.
	 * 
	 * @param value
	 *            The new value.
	 */
	public void setValue(String value) {
		this.value = value;
	}

	/**
	 * Return the current value.
	 * 
	 * @return String value The current value.
	 */
	public String getValue() {
		return value;
	}

	// --------------------------------------------------------- Public Methods

	/**
	 * Get a String representation of this pair.
	 * 
	 * @return A string representation.
	 */
	public String toString() {
		return ("name=" + name + ", " + "value=" + value);
	}

	public boolean equals(final Object object) {
		if (object == null)
			return false;
		if (this == object)
			return true;
		if (object instanceof NameValuePair) {
			NameValuePair that = (NameValuePair) object;
			return LangUtils.equals(this.name, that.name)
					&& LangUtils.equals(this.value, that.value);
		} else {
			return false;
		}
	}

	public int hashCode() {
		int hash = LangUtils.HASH_SEED;
		hash = LangUtils.hashCode(hash, this.name);
		hash = LangUtils.hashCode(hash, this.value);
		return hash;
	}
}
